/*
 * Copyright 2011-2012 by The Regents of the University of California Licensed
 * under the Apache License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. you may obtain a copy of the
 * License from
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package edu.ucsd.db.bassarisk.storage.reading;

import java.nio.ByteBuffer;

import edu.ucsd.db.bassarisk.data.api.IValueType;
import edu.ucsd.db.bassarisk.data.api.IValueType.ITypeTools;
import edu.ucsd.db.bassarisk.data.api.IValueType.IValueReference;
import edu.ucsd.db.bassarisk.storage.loading.ColumnSegmentInfo;

public interface IColumnIndexReader<VT extends IValueType> extends
    IColumnSegmentIndexReader<VT> {

  public class DrawerInfo<VT extends IValueType> extends ColumnSegmentInfo<VT> {

    private long drawerAddress;
    private int drawerIndex;

    public DrawerInfo(final ITypeTools<VT> columnTypeTools) {
      super(columnTypeTools);
    }

    public int getDrawerHeaderPageIndex() {
      return (int) (this.drawerAddress & 0xFF);
    }

    public int getDrawerIndex() {
      return this.drawerIndex;
    }

    public int getDrawerPageId() {
      return (int) (this.drawerAddress >> 8);
    }

    public void reset(final int drawerIndex, final long drawerAddress,
                      final long entryCount, final long firstEntryIndex) {
      this.drawerIndex = drawerIndex;
      this.drawerAddress = drawerAddress;
      super.reset(entryCount, firstEntryIndex);
    }

  }

  int getColumnDrawerCount();

  int getColumnIndexVersion();

  void initialize(ByteBuffer headerDrawerBuffer, 
                  ColumnReader<VT>.ColumnInfo columnInfo,
                  int headerCardIndex);

  DrawerInfo<VT> makeDrawerInfoInstance();

  void setDrawerInfo(int cardIndex, DrawerInfo<VT> info);

  boolean setDrawerInfoForEntryIndex(int targetEntryIndex, DrawerInfo<VT> info);

  boolean setDrawerInfoForValue(IValueReference<VT> value, DrawerInfo<VT> info);

  boolean setNextDrawerInfo(DrawerInfo<VT> info);

}
